Skip to content

Vtadmin monitoring integration #19000

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
c-r-dev wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Vtadmin monitoring integration #19000

c-r-dev wants to merge 4 commits into from
+810 −4

Conversation

@c-r-dev
Copy link
Contributor

@c-r-dev c-r-dev commented Dec 5, 2025 •
edited by mattlord
Loading

Description

This PR implements the frontend support for integrating external monitoring tools (like Grafana and PMM) directly into VTAdmin, addressing some of the goals outlined in RFC: Integrate PMM into vtadmin (#11191).

Added a flexible, configuration-driven mechanism to link VTAdmin entities (Clusters, Tablets, Gates) to external dashboards. This allows VTAdmin to serve as a "single view" for Vitess operations, enabling users to navigate seamlessly from topology views to deep-dive metrics.

Introduced new environment variables to define dashboard URL patterns. These templates support dynamic placeholders that are replaced with context-specific data at runtime.

  • VITE_VITESS_MONITORING_CLUSTER_TEMPLATE: For cluster-level metrics.
  • VITE_VITESS_MONITORING_VTTABLET_TEMPLATE: For tablet metrics.
  • VITE_VITESS_MONITORING_VTGATE_TEMPLATE: For vtgate metrics.
  • VITE_MYSQL_MONITORING_TEMPLATE: For underlying MySQL instance metrics (e.g., PMM).

Supported Placeholders: {cluster}, {keyspace}, {shard}, {alias}, {hostname}, {type}, {cell}, {pool}.

UI Integration

  • VTClusters View: Added a column linking to the cluster dashboard (Grafana) with metrics from vtctld.
  • Gates View: Added a column linkting to the VTGates dashboard (Grafana) with metrics from vtgate.
  • Tablets View: Added a columns linkting to the Tablet metrics dashboard (Grafana) and MySQL metrics dashboard (PMM).
  • Context-Aware: Links are only rendered if the corresponding environment variable is configured.

Demo & Verification

To demonstrate this functionality and provide a reference implementation, I have updated the examples/vtadmin directory.

  • Co-deployed Stack: The example now includes a docker-compose setup with Prometheus, Grafana, and PMM running alongside Vitess.
  • Pre-configuration: The example docker-compose.yml is pre-wired with the new VITE_ variables to link VTAdmin to the local monitoring stack.
cd examples/vtadmin
make up
monitoring_links_demo.mp4

Fixes: #11191

@vitess-bot
Copy link
Contributor

vitess-bot bot commented Dec 5, 2025

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Dec 5, 2025
@github-actions github-actions bot added this to the v24.0.0 milestone Dec 5, 2025
@c-r-dev c-r-dev marked this pull request as ready for review December 15, 2025 17:12
@mattlord mattlord self-requested a review December 15, 2025 17:15
@promptless
Copy link
Contributor

promptless bot commented Dec 15, 2025

📝 Documentation updates detected!

New suggestion: Add changelog entry for VTAdmin monitoring integration

@promptless
Copy link
Contributor

promptless bot commented Dec 15, 2025

📝 Documentation updates detected!

New suggestion: Document VTAdmin monitoring integration

@mattlord mattlord added Type: Feature Component: VTAdmin VTadmin interface and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Dec 15, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Jan 18, 2026

This PR is being marked as stale because it has been open for 30 days with no activity. To rectify, you may do any of the following:

  • Push additional commits to the associated branch.
  • Remove the stale label.
  • Add a comment indicating why it is not stale.

If no action is taken within 7 days, this PR will be closed.

@github-actions github-actions bot added the Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. label Jan 18, 2026
@github-actions github-actions bot removed the Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. label Jan 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@beingnoble03 beingnoble03 Awaiting requested review from beingnoble03 beingnoble03 is a code owner

@mattlord mattlord Awaiting requested review from mattlord

@derekperkins derekperkins Awaiting requested review from derekperkins

At least 2 approving reviews are required to merge this pull request.

Assignees

No one assigned

Labels

Component: VTAdmin VTadmin interface NeedsWebsiteDocsUpdate What it says Type: Feature

Projects

None yet

Milestone

v24.0.0

Development

Successfully merging this pull request may close these issues.

RFC: Integrate PMM into vtadmin

2 participants

@c-r-dev @mattlord